<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.math.optimization.linear;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.Collection;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.commons.math.optimization.GoalType;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.commons.math.optimization.OptimizationException;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.math.optimization.RealPointValuePair;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /** <a name="line.26"></a>
<FONT color="green">027</FONT>     * This interface represents an optimization algorithm for linear problems.<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;Optimization algorithms find the input point set that either {@link GoalType<a name="line.28"></a>
<FONT color="green">029</FONT>     * maximize or minimize} an objective function. In the linear case the form of<a name="line.29"></a>
<FONT color="green">030</FONT>     * the function is restricted to<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;pre&gt;<a name="line.31"></a>
<FONT color="green">032</FONT>     * c&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... c&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; = v<a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;/pre&gt;<a name="line.33"></a>
<FONT color="green">034</FONT>     * and there may be linear constraints too, of one of the forms:<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;ul&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     *   &lt;li&gt;c&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... c&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; = v&lt;/li&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     *   &lt;li&gt;c&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... c&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; &amp;lt;= v&lt;/li&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     *   &lt;li&gt;c&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... c&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; &gt;= v&lt;/li&gt;<a name="line.38"></a>
<FONT color="green">039</FONT>     *   &lt;li&gt;l&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... l&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; + l&lt;sub&gt;cst&lt;/sub&gt; =<a name="line.39"></a>
<FONT color="green">040</FONT>     *       r&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... r&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; + r&lt;sub&gt;cst&lt;/sub&gt;&lt;/li&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     *   &lt;li&gt;l&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... l&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; + l&lt;sub&gt;cst&lt;/sub&gt; &amp;lt;=<a name="line.41"></a>
<FONT color="green">042</FONT>     *       r&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... r&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; + r&lt;sub&gt;cst&lt;/sub&gt;&lt;/li&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     *   &lt;li&gt;l&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... l&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; + l&lt;sub&gt;cst&lt;/sub&gt; &gt;=<a name="line.43"></a>
<FONT color="green">044</FONT>     *       r&lt;sub&gt;1&lt;/sub&gt;x&lt;sub&gt;1&lt;/sub&gt; + ... r&lt;sub&gt;n&lt;/sub&gt;x&lt;sub&gt;n&lt;/sub&gt; + r&lt;sub&gt;cst&lt;/sub&gt;&lt;/li&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>     * &lt;/ul&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * where the c&lt;sub&gt;i&lt;/sub&gt;, l&lt;sub&gt;i&lt;/sub&gt; or r&lt;sub&gt;i&lt;/sub&gt; are the coefficients of<a name="line.46"></a>
<FONT color="green">047</FONT>     * the constraints, the x&lt;sub&gt;i&lt;/sub&gt; are the coordinates of the current point and<a name="line.47"></a>
<FONT color="green">048</FONT>     * v is the value of the constraint.<a name="line.48"></a>
<FONT color="green">049</FONT>     * &lt;/p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     * @version $Revision: 799857 $ $Date: 2009-08-01 09:07:12 -0400 (Sat, 01 Aug 2009) $<a name="line.50"></a>
<FONT color="green">051</FONT>     * @since 2.0<a name="line.51"></a>
<FONT color="green">052</FONT>     */<a name="line.52"></a>
<FONT color="green">053</FONT>    public interface LinearOptimizer {<a name="line.53"></a>
<FONT color="green">054</FONT>    <a name="line.54"></a>
<FONT color="green">055</FONT>        /** Set the maximal number of iterations of the algorithm.<a name="line.55"></a>
<FONT color="green">056</FONT>         * @param maxIterations maximal number of function calls<a name="line.56"></a>
<FONT color="green">057</FONT>         */<a name="line.57"></a>
<FONT color="green">058</FONT>        void setMaxIterations(int maxIterations);<a name="line.58"></a>
<FONT color="green">059</FONT>    <a name="line.59"></a>
<FONT color="green">060</FONT>        /** Get the maximal number of iterations of the algorithm.<a name="line.60"></a>
<FONT color="green">061</FONT>         * @return maximal number of iterations<a name="line.61"></a>
<FONT color="green">062</FONT>         */<a name="line.62"></a>
<FONT color="green">063</FONT>        int getMaxIterations();<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>        /** Get the number of iterations realized by the algorithm.<a name="line.65"></a>
<FONT color="green">066</FONT>         * &lt;p&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>         * The number of evaluations corresponds to the last call to the<a name="line.67"></a>
<FONT color="green">068</FONT>         * {@link #optimize(LinearObjectiveFunction, Collection, GoalType, boolean) optimize}<a name="line.68"></a>
<FONT color="green">069</FONT>         * method. It is 0 if the method has not been called yet.<a name="line.69"></a>
<FONT color="green">070</FONT>         * &lt;/p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>         * @return number of iterations<a name="line.71"></a>
<FONT color="green">072</FONT>         */<a name="line.72"></a>
<FONT color="green">073</FONT>        int getIterations();<a name="line.73"></a>
<FONT color="green">074</FONT>    <a name="line.74"></a>
<FONT color="green">075</FONT>        /** Optimizes an objective function.<a name="line.75"></a>
<FONT color="green">076</FONT>         * @param f linear objective function<a name="line.76"></a>
<FONT color="green">077</FONT>         * @param constraints linear constraints<a name="line.77"></a>
<FONT color="green">078</FONT>         * @param goalType type of optimization goal: either {@link GoalType#MAXIMIZE}<a name="line.78"></a>
<FONT color="green">079</FONT>         * or {@link GoalType#MINIMIZE}<a name="line.79"></a>
<FONT color="green">080</FONT>         * @param restrictToNonNegative whether to restrict the variables to non-negative values<a name="line.80"></a>
<FONT color="green">081</FONT>         * @return point/value pair giving the optimal value for objective function<a name="line.81"></a>
<FONT color="green">082</FONT>         * @exception OptimizationException if no solution fulfilling the constraints<a name="line.82"></a>
<FONT color="green">083</FONT>         * can be found in the allowed number of iterations<a name="line.83"></a>
<FONT color="green">084</FONT>         */<a name="line.84"></a>
<FONT color="green">085</FONT>       RealPointValuePair optimize(LinearObjectiveFunction f, Collection&lt;LinearConstraint&gt; constraints,<a name="line.85"></a>
<FONT color="green">086</FONT>                                   GoalType goalType, boolean restrictToNonNegative)<a name="line.86"></a>
<FONT color="green">087</FONT>            throws OptimizationException;<a name="line.87"></a>
<FONT color="green">088</FONT>    <a name="line.88"></a>
<FONT color="green">089</FONT>    }<a name="line.89"></a>




























































</PRE>
</BODY>
</HTML>
